Get-RASScheduleMessage

NAME

Get-RASScheduleMessage

SYNOPSIS

Retrieves schedule message information for a Schedule.

SYNTAX

Get-RASScheduleMessage [-Id] <uint> -ObjType {RDS | VDI | AVD} [-MessageId <uint>] [-TargetType {Host | HostPool}] [<CommonParameters>]

Get-RASScheduleMessage [[-Name] <string>] [[-SiteId] <uint>] -ObjType {RDS | VDI | AVD} [-MessageId <uint>] [-TargetType {Host | HostPool}] [<CommonParameters>]

DESCRIPTION

Retrieves schedule message information for a Schedule.

PARAMETERS


-MessageId <uint>
Scheduler job message ID. 

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Name <string>
Scheduler job name. 

        Required?                    false
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID from which to retrieve the schedule job. 

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Id <uint>
Scheduler job ID. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ObjType <ScheduleObjType>
Schedule object type.

Possible values: RDS, VDI, AVD 

        Required?                    true
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-TargetType <ScheduleTargetType>
Schedule target type.

Possible values: Host, HostPool 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

<CommonParameters> 
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

ScheduleMessage

EXAMPLES


---------- EXAMPLE 1 ----------

Get-RASScheduleMessage -ObjType VDI -Name "SchedItem"

Retrieves the list of Messages from the schedule item specified by name.
---------- EXAMPLE 2 ----------

Get-RASScheduleMessage -ObjType VDI -Id 1

Retrieves the list of Messages from the schedule item specified by id.
---------- EXAMPLE 3 ----------

Get-RASScheduleMessage -ObjType VDI -Name "SchedItem" -MessageId 1

Retrieves Message specified by id from the schedule item specified by name.
---------- EXAMPLE 4 ----------

Get-RASScheduleMessage -ObjType VDI -Id 1 -MessageId 1

Retrieves Message specified by id from the schedule item specified by id.

RELATED LINKS